docs: update installation.rst #17
Conversation
| A specific branch named `no_big_files` is available for practical inclusion as a git submodule | ||
| in your own repository. This does not include the default database and example images, making | ||
| it less than 1 MB. For a specific application you probably want a custom database anyway. |
There was a problem hiding this comment.
this branch isn't valid in the cedar-solve fork and we do include the default database in the python wheel. the download size is only 8.1MB for the wheel.
docs/installation.rst
Outdated
| You can test that it works by invoking the database generator command:: | ||
|
|
||
| You can test that it works by running the example provided in the GitHub repo. | ||
| tetra3-gen-db --help |
There was a problem hiding this comment.
you can't run the example when installing from a wheel, we don't include that directory or the images inside the wheel.
There was a problem hiding this comment.
why not? The idea is that the pip install is the minimum needed to run cedar-solve?
So if folks want to run the tests they can do the source code install documented in the installation.rst, right?
There was a problem hiding this comment.
if they install it from pypi its assumed they are integrating it into their project in some way.
they can download the source or clone the git repo to run the tests and the example.
an alternative to including the example would be a minimal example described in the documentation as a tutorial.
| A specific branch named `no_big_files` is available for practical inclusion as a git submodule | ||
| in your own repository. This does not include the default database and example images, making | ||
| it less than 1 MB. For a specific application you probably want a custom database anyway. | ||
|
|
||
| If problems arise | ||
| ----------------- | ||
| Please get in touch by `filing an issue <https://github.com/smroid/cedar-solve/issues>`_. |
There was a problem hiding this comment.
While you're here, can you also add something like:
You can also join the Cedar Discord server at https://discord.gg/xbDrUyXP.
| @@ -3,7 +3,7 @@ Installation | |||
|
|
|||
| Getting Python | |||
| -------------- | |||
| Cedar-solve is written for Python 3.7 or later (and therefore runs on almost any platform) and should | |||
| Cedar-solve is written for Python 3.8 or later (and therefore runs on almost any platform) and should | |||
There was a problem hiding this comment.
this was changed due to math.comb not existing in 3.7, the pyproject.toml file specifies >=3.8
docs/installation.rst
Outdated
| directly in your Python project as a module and use, or see below for how to install it. | ||
| You have two options to manually download the source code. | ||
|
|
||
| 1. Download the release of your choice by going to `GitHub Releasess <https://github.com/smroid/cedar-solve/releases>`_ |
updated to reflect being able to install from PyPi.
removed some things that don't make sense anymore.